fix: properly handle Raises section for GoogleDocstring #56
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
google-cla
bot
added
the
cla: yes
tbpg
reviewed
Jun 23, 2021
docfx_yaml/extension.py
Outdated
Comment on lines
558
to
559
| for PATTERN in [REF_PATTERN, REF_PATTERN_LAST]: | ||
| lines = _resolve_reference_in_module_summary(PATTERN, lines) |
There was a problem hiding this comment.
Drop the for loop and call the function directly twice? I was confused at first with what was happening here.
There was a problem hiding this comment.
done. I'll add comments as well.
tests/test_unit.py
Outdated
Comment on lines
79
to
80
| PATTERNS = [REF_PATTERN, REF_PATTERN_LAST] | ||
| for PATTERN in PATTERNS: |
There was a problem hiding this comment.
Is the Python style to use all caps for references to constants? Would expect this to be pattern.
There was a problem hiding this comment.
references shouldn't be. Done.
| @@ -73,6 +73,7 @@ class Bcolors: | |||
| REFFUNCTION = 'func' | |||
| INITPY = '__init__.py' | |||
| REF_PATTERN = ':(py:)?(func|class|meth|mod|ref|attr|exc):`~?[a-zA-Z0-9_\.<> ]*?`' | |||
| REF_PATTERN_LAST = '~(([a-zA-Z0-9_<>]*\.)*[a-zA-Z0-9_<>]*)' | |||
There was a problem hiding this comment.
Add a comment saying what this is for?
tbpg
approved these changes
Jun 24, 2021
docfx_yaml/extension.py
Outdated
| @@ -184,23 +187,31 @@ def _refact_example_in_module_summary(lines): | |||
| return new_lines | |||
|
|
|||
|
|
|||
| def _resolve_reference_in_module_summary(lines): | |||
| def _resolve_reference_in_module_summary(PATTERN, lines): | |||
There was a problem hiding this comment.
Same PATTERN vs pattern comment from before.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before you open a pull request, note that this repository is forked from here.
Unless the issue you're trying to solve is unique to this specific repository,
please file an issue and/or send changes upstream to the original as well.
When there's special characters in
Raises section for type,
GoogleDocstringdoes not handle it well and crashes. To avoid this, and to also have it properly be handled byGoogleDocstring, I've decided to strip all occurrences of~typeand<xref:type>entries from special characters before runningGoogleDocstring.Added a unit test to verify that the strings get parsed properly.
Since this touches on the same function
_extract_docstring_infoas #55, I'll be adding unittest for the function's portion after it's merged and I've resolved git merge conflicts.Fixes #53